Server Automation Guide - ScxV6Object.Rename Method

Renames a database object

Parameters

Remarks

The Rename method will attempt to rename a database object.

The operation may fail if:

The user does not have configuration privileges for the object.
An existing object with the same name already exists in the parent group of the object.
The NewName argument contains invalid characters, for example a full stop.

Example:

The following example written in VB.NET shows the Rename method being used to rename a point:

' Connect to the server

Dim Svr As ScxV6DbClient.ScxV6Server

Svr = New ScxV6DbClient.ScxV6Server

Svr.Connect("MAIN", "", "")

' Find the point we wish to rename

Dim Obj As ScxV6DbClient.ScxV6Object

Obj = Svr.FindObject("Group.New Analogue Point")

' Rename the point

Obj.Rename("Test Point")

' Disconnect

Svr.Disconnect()